home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_qt.idb / usr / freeware / catman / p_man / cat3 / qaccel.Z / qaccel
Encoding:
Text File  |  1998-10-28  |  14.8 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       QAccel - Handles keyboard accelerator    keys
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       #include <qaccel.h>
  13.  
  14.       Inherits QObject.
  15.  
  16.     PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss
  17.       QQQQAAAAcccccccceeeellll (((( QQQQWWWWiiiiddddggggeeeetttt **** _p_a_r_e_n_t,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr    **** _n_a_m_e====0000 ))))
  18.       ~~~~QQQQAAAAcccccccceeeellll ()
  19.       bbbboooooooollll iiiissssEEEEnnnnaaaabbbblllleeeedddd (((()))) ccccoooonnnnsssstttt
  20.       vvvvooooiiiidddd sssseeeettttEEEEnnnnaaaabbbblllleeeedddd (((( bbbboooooooollll ))))
  21.       uuuuiiiinnnntttt ccccoooouuuunnnntttt (((())))    ccccoooonnnnsssstttt
  22.       iiiinnnntttt iiiinnnnsssseeeerrrrttttIIIItttteeeemmmm (((( iiiinnnntttt _k_e_y,,,, iiiinnnntttt    _i_d====----1111 ))))
  23.       vvvvooooiiiidddd rrrreeeemmmmoooovvvveeeeIIIItttteeeemmmm (((( iiiinnnntttt    iiiidddd ))))
  24.       vvvvooooiiiidddd cccclllleeeeaaaarrrr (((())))
  25.       iiiinnnntttt kkkkeeeeyyyy (((( iiiinnnntttt    iiiidddd ))))
  26.       iiiinnnntttt ffffiiiinnnnddddKKKKeeeeyyyy ((((    iiiinnnntttt kkkkeeeeyyyy    )))) ccccoooonnnnsssstttt
  27.       bbbboooooooollll iiiissssIIIItttteeeemmmmEEEEnnnnaaaabbbblllleeeedddd (((( iiiinnnntttt iiiidddd ))))    ccccoooonnnnsssstttt
  28.       vvvvooooiiiidddd sssseeeettttIIIItttteeeemmmmEEEEnnnnaaaabbbblllleeeedddd ((((    iiiinnnntttt _i_d,,,,    bbbboooooooollll eeeennnnaaaabbbblllleeee ))))
  29.       bbbboooooooollll ccccoooonnnnnnnneeeeccccttttIIIItttteeeemmmm (((( iiiinnnntttt _i_d,,,, ccccoooonnnnsssstttt QQQQOOOObbbbjjjjeeeecccctttt **** _r_e_c_e_i_v_e_r,,,, ccccoooonnnnsssstttt
  30.           cccchhhhaaaarrrr **** mmmmeeeemmmmbbbbeeeerrrr ))))
  31.       bbbboooooooollll ddddiiiissssccccoooonnnnnnnneeeeccccttttIIIItttteeeemmmm ((((    iiiinnnntttt _i_d,,,,    ccccoooonnnnsssstttt QQQQOOOObbbbjjjjeeeecccctttt ****    _r_e_c_e_i_v_e_r,,,,
  32.           ccccoooonnnnsssstttt cccchhhhaaaarrrr **** mmmmeeeemmmmbbbbeeeerrrr ))))
  33.       vvvvooooiiiidddd rrrreeeeppppaaaaiiiirrrrEEEEvvvveeeennnnttttFFFFiiiilllltttteeeerrrr (((())))
  34.  
  35.     SSSSiiiiggggnnnnaaaallllssss
  36.       vvvvooooiiiidddd aaaaccccttttiiiivvvvaaaatttteeeedddd (((( iiiinnnntttt iiiidddd ))))
  37.  
  38.     PPPPrrrrooootttteeeecccctttteeeedddd MMMMeeeemmmmbbbbeeeerrrrssss
  39.       vvvviiiirrrrttttuuuuaaaallll bbbboooooooollll eeeevvvveeeennnnttttFFFFiiiilllltttteeeerrrr (((( QQQQOOOObbbbjjjjeeeecccctttt ****,,,,    QQQQEEEEvvvveeeennnntttt **** ))))
  40.  
  41.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  42.       The QAccel class handles keyboard accelerator    keys.
  43.  
  44.       A QAccel contains a list of accelerator items. Each
  45.       accelerator item consists of an identifier and a keyboard
  46.       code combined    with modifiers (SHIFT, CTRL, ALT or
  47.       ASCII_ACCEL).
  48.  
  49.       For example, CTRL + Key_P could be a shortcut    for printing a
  50.       document. The    key codes are listed in    qkeycode.h.
  51.  
  52.       When pressed,    an accelerator key sends out the signal
  53.       activated() with a number that identifies this particular
  54.       accelerator item. Accelerator    items can also be individually
  55.       connected, so    that two different keys    will activate two
  56.       different slots (see connectItem()).
  57.  
  58.       A QAccel object handles key events to    the top    level window
  59.       containing _p_a_r_e_n_t, and hence to any child widgets of that
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 9/22/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))
  71.  
  72.  
  73.  
  74.       window. Note that the    accelerator will be deleted only when
  75.       the _p_a_r_e_n_t is    deleted, and will consume relevant key events
  76.       until    then.
  77.  
  78.       Example:
  79.  
  80.            QAccel *a = new QAccel( myWindow    );      // create accels for myWindow
  81.            a->connectItem( a->insertItem(Key_P+CTRL), // adds Ctrl+P accelerator
  82.                    myWindow,          // connected to myWindow's
  83.                    SLOT(printDoc())    );      // printDoc()    slot
  84.  
  85.       See also: QKeyEvent, QWidget::keyPressEvent(),
  86.       QMenuData::setAccel(), QButton::setAccel() and GUI Design
  87.       Handbook: Keyboard Shortcuts,
  88.  
  89.       Examples:  application/application.cpp
  90.  
  91.      MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  92.      QQQQAAAAcccccccceeeellll::::::::QQQQAAAAcccccccceeeellll (((( QQQQWWWWiiiiddddggggeeeetttt ****    ppppaaaarrrreeeennnntttt,,,,    ccccoooonnnnsssstttt cccchhhhaaaarrrr **** nnnnaaaammmmeeee====0000 ))))
  93.       Creates a QAccel object with a parent    widget and a name.
  94.  
  95.      QQQQAAAAcccccccceeeellll::::::::~~~~QQQQAAAAcccccccceeeellll (((())))
  96.       Destroys the accelerator object.
  97.  
  98.      vvvvooooiiiidddd QQQQAAAAcccccccceeeellll::::::::aaaaccccttttiiiivvvvaaaatttteeeedddd (((( iiiinnnntttt iiiidddd )))) [[[[ssssiiiiggggnnnnaaaallll]]]]
  99.       This signal is emitted when an accelerator key is pressed.
  100.       _i_d is    a number that identifies this particular accelerator
  101.       item.
  102.  
  103.      vvvvooooiiiidddd QQQQAAAAcccccccceeeellll::::::::cccclllleeeeaaaarrrr    (((())))
  104.       Removes all accelerator items.
  105.  
  106.      bbbboooooooollll QQQQAAAAcccccccceeeellll::::::::ccccoooonnnnnnnneeeeccccttttIIIItttteeeemmmm ((((    iiiinnnntttt iiiidddd,,,,    ccccoooonnnnsssstttt QQQQOOOObbbbjjjjeeeecccctttt ****    rrrreeeecccceeeeiiiivvvveeeerrrr,,,,
  107.       ccccoooonnnnsssstttt    cccchhhhaaaarrrr **** mmmmeeeemmmmbbbbeeeerrrr ))))
  108.       Connects an accelerator item to a slot/signal    in another
  109.       object.
  110.  
  111.       Arguments:
  112.  
  113.       _i_d is    the accelerator    item id.
  114.  
  115.       _r_e_c_e_i_v_e_r is the object to receive a signal.
  116.  
  117.       _m_e_m_b_e_r is a slot or signal function in the receiver.
  118.  
  119.           a->connectItem( 201, mainView, SLOT(quit()) );
  120.  
  121.       See also: disconnectItem().
  122.  
  123.       Examples:  application/application.cpp
  124.  
  125.      uuuuiiiinnnntttt QQQQAAAAcccccccceeeellll::::::::ccccoooouuuunnnntttt    (((()))) ccccoooonnnnsssstttt
  126.  
  127.  
  128.  
  129.      PPPPaaaaggggeeee 2222                         ((((pppprrrriiiinnnntttteeeedddd 9999////22222222////99998888))))
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))
  137.  
  138.  
  139.  
  140.       Returns the number of    accelerator items.
  141.  
  142.      bbbboooooooollll QQQQAAAAcccccccceeeellll::::::::ddddiiiissssccccoooonnnnnnnneeeeccccttttIIIItttteeeemmmm (((( iiiinnnntttt iiiidddd,,,, ccccoooonnnnsssstttt QQQQOOOObbbbjjjjeeeecccctttt **** rrrreeeecccceeeeiiiivvvveeeerrrr,,,,
  143.       ccccoooonnnnsssstttt    cccchhhhaaaarrrr **** mmmmeeeemmmmbbbbeeeerrrr ))))
  144.       Disconnects an accelerator item from a function in another
  145.       object.
  146.  
  147.       See also: connectItem().
  148.  
  149.      bbbboooooooollll QQQQAAAAcccccccceeeellll::::::::eeeevvvveeeennnnttttFFFFiiiilllltttteeeerrrr ((((    QQQQOOOObbbbjjjjeeeecccctttt    ****,,,, QQQQEEEEvvvveeeennnntttt **** eeee ))))    [[[[vvvviiiirrrrttttuuuuaaaallll
  150.       pppprrrrooootttteeeecccctttteeeedddd]]]]
  151.       Processes accelerator    events intended    for the    top level
  152.       widget.
  153.  
  154.       Reimplemented    from QObject.
  155.  
  156.      iiiinnnntttt QQQQAAAAcccccccceeeellll::::::::ffffiiiinnnnddddKKKKeeeeyyyy (((( iiiinnnntttt kkkkeeeeyyyy )))) ccccoooonnnnsssstttt
  157.       Returns the identifier of the    accelerator item with the key
  158.       code _k_e_y, or -1 if the item cannot be    found.
  159.  
  160.      iiiinnnntttt QQQQAAAAcccccccceeeellll::::::::iiiinnnnsssseeeerrrrttttIIIItttteeeemmmm (((( iiiinnnntttt kkkkeeeeyyyy,,,, iiiinnnntttt iiiidddd====----1111 ))))
  161.       Inserts an accelerator item and returns the item's
  162.       identifier.
  163.  
  164.       Arguments:
  165.  
  166.       _k_e_y is a key code plus a combination of SHIFT, CTRL and ALT.
  167.  
  168.      will be assigned a    unique identifier.
  169.       _i_d is    the accelerator    item id. If _i_d is negative, then the item
  170.  
  171.           QAccel *a    = new QAccel( myWindow );      // create accels for myWindow
  172.           a->insertItem( Key_P + CTRL, 200 );      // Ctrl+P to print document
  173.           a->insertItem( Key_X + ALT , 201 );      // Alt+X  to quit
  174.           a->insertItem( ASCII_ACCEL + 'q',    202 );      // ASCII 'q' to quit
  175.           a->insertItem( Key_D );              // gets id 3
  176.           a->insertItem( Key_P + CTRL + SHIFT );      // gets id 4
  177.  
  178.       Examples:  application/application.cpp
  179.  
  180.      bbbboooooooollll QQQQAAAAcccccccceeeellll::::::::iiiissssEEEEnnnnaaaabbbblllleeeedddd (((()))) ccccoooonnnnsssstttt
  181.       Returns TRUE if the accelerator is enabled, or FALSE if it
  182.       is disabled.
  183.  
  184.       See also: setEnabled() and isItemEnabled().
  185.  
  186.      bbbboooooooollll QQQQAAAAcccccccceeeellll::::::::iiiissssIIIItttteeeemmmmEEEEnnnnaaaabbbblllleeeedddd    (((( iiiinnnntttt iiiidddd )))) ccccoooonnnnsssstttt
  187.       Returns TRUE if the accelerator item with the    identifier _i_d
  188.       is enabled. Returns FALSE if the item    is disabled or cannot
  189.       be found.
  190.  
  191.       See also: setItemEnabled() and isEnabled().
  192.  
  193.  
  194.  
  195.      Page 3                         (printed 9/22/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))       QQQQAAAAcccccccceeeellll((((3333qqqqtttt))))
  203.  
  204.  
  205.  
  206.      iiiinnnntttt QQQQAAAAcccccccceeeellll::::::::kkkkeeeeyyyy (((( iiiinnnntttt iiiidddd ))))
  207.       Returns the key code of the accelerator item with the
  208.       identifier _i_d, or zero if the    id cannot be found.
  209.  
  210.      vvvvooooiiiidddd QQQQAAAAcccccccceeeellll::::::::rrrreeeemmmmoooovvvveeeeIIIItttteeeemmmm (((( iiiinnnntttt iiiidddd ))))
  211.       Removes the accelerator item with the    identifier _i_d.
  212.  
  213.      vvvvooooiiiidddd QQQQAAAAcccccccceeeellll::::::::rrrreeeeppppaaaaiiiirrrrEEEEvvvveeeennnnttttFFFFiiiilllltttteeeerrrr (((())))
  214.       Make sure that the accelerator is watching the correct event
  215.       filter. Used by QWidget::recreate().
  216.  
  217.      vvvvooooiiiidddd QQQQAAAAcccccccceeeellll::::::::sssseeeettttEEEEnnnnaaaabbbblllleeeedddd (((( bbbboooooooollll eeeennnnaaaabbbblllleeee ))))
  218.       Enables the accelerator if _e_n_a_b_l_e is TRUE, or    disables it if
  219.       _e_n_a_b_l_e is FALSE.
  220.  
  221.       Individual keys can also be enabled or disabled.
  222.  
  223.       See also: isEnabled()    and setItemEnabled().
  224.  
  225.      vvvvooooiiiidddd QQQQAAAAcccccccceeeellll::::::::sssseeeettttIIIItttteeeemmmmEEEEnnnnaaaabbbblllleeeedddd (((( iiiinnnntttt iiiidddd,,,, bbbboooooooollll    eeeennnnaaaabbbblllleeee ))))
  226.       Enables or disables an accelerator item.
  227.  
  228.       Arguments:
  229.  
  230.       _i_d is    the item identifier.
  231.  
  232.       _e_n_a_b_l_e specifies whether the item should be enabled or disabled.
  233.  
  234.       See also:  isItemEnabled() and isEnabled().
  235.  
  236.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  237.       hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqaaaacccccccceeeellll....hhhhttttmmmmllll
  238.  
  239.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  240.       Copyright 1992-1997 Troll Tech AS.  See the LICENSE file
  241.       included in the distribution for a complete license
  242.       statement.
  243.  
  244.      AAAAUUUUTTTTHHHHOOOORRRR
  245.       Generated automatically from the source code.
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                         (printed 9/22/98)
  262.  
  263.  
  264.  
  265.